Skip to content

[AAASM-2936] 📝 (docs): Build full multi-page Examples section#118

Merged
Chisanan232 merged 16 commits into
masterfrom
v0.0.1/AAASM-2936/python_docs_examples
Jun 14, 2026
Merged

[AAASM-2936] 📝 (docs): Build full multi-page Examples section#118
Chisanan232 merged 16 commits into
masterfrom
v0.0.1/AAASM-2936/python_docs_examples

Conversation

@Chisanan232

@Chisanan232 Chisanan232 commented Jun 14, 2026

Copy link
Copy Markdown
Contributor

Description

Builds a complete, multi-page Examples section into the python-sdk mkdocs docs, grounded entirely in the real agent-assembly-examples sources (README + src/). This expands the original single-page refresh of framework-examples.md into a full section so each framework gets a detailed, source-accurate walkthrough.

New docs/examples/ section

  • Overview (examples/index.md) — entry point, the offline-by-default note, a "start here" path, and a table mapping each example to the governance control it demonstrates.
  • Preparing the runtime environment (examples/preparing-the-runtime-environment.md) — shared prerequisites to run any Python example: install (pip install agent-assembly / uv sync --extra dev), cloning agent-assembly-examples, the real uv run python src/main.py (+ --mock) commands, mock vs. real-provider mode, and the example env vars (AGENT_ASSEMBLY_GATEWAY_URL default http://localhost:8080, AGENT_ASSEMBLY_API_KEY). Includes a note reconciling these example-specific vars with the SDK's own AASM_* / :7391 resolver chain.
  • Framework support (examples/framework-support.md) — the refreshed adapter <-> example status table and the universal init_assembly() pattern, relocated here from docs/guides/framework-examples.md (via git mv, history preserved) and re-linked to the per-framework pages. Adds a LlamaIndex row.
  • Nine per-framework pages, one per example, each with: what it demonstrates, the framework/library + version pins, how the init_assembly() adapter flow works, prerequisites & real run commands, an annotated code walkthrough from policy.py/tools.py/main.py, mkdocs admonitions for offline/mock caveats, the verbatim expected output, and links:
    • langchain-basic-agent, langchain-research-agent, langgraph, crewai-research-crew, openai-agents-sdk, pydantic-ai, google-adk, llamaindex-tool-policy, custom-tool-policy.

Nav + link wiring

  • Adds a top-level Examples nav section (Overview -> Preparing the runtime environment -> Framework support -> the 9 framework pages) to mkdocs.yml.
  • Removes the old guides/framework-examples.md nav entry and repoints all inbound references (index.md, quick-start.md, configuration.md, guides/index.md) to the new Examples section. The internal #langchain-quick-start anchor is preserved.

Docs-only change. Accuracy was the priority: every command, env var, flag, code excerpt, and expected-output block is taken from the real example README/src — nothing invented.

Type of Change

  • ✨ New feature
  • 🔧 Bug fix
  • ♻️ Refactoring
  • 📚 Documentation update
  • 🚀 Release

Breaking Changes

  • No
  • Yes (please describe below)

Related Issues

  • Related JIRA ticket: AAASM-2936
  • Related GitHub issues: N/A

Closes AAASM-2936

Testing

Describe the testing performed for this PR:

  • Unit tests added/updated
  • Integration tests added/updated
  • Manual testing performed
  • No tests required (explain why)

Docs-only Markdown change — no code paths touched. Ran mkdocs build --strict locally (with the project's docs dependency group): the build passes with no broken nav entries and no broken internal links across the new section. Each per-example page was drafted directly from the upstream README.md + src/*.py so commands, env vars, code excerpts, and expected output match the real examples.

Checklist

  • Code follows project style guidelines
  • Self-review completed
  • Comments added for complex logic
  • Documentation updated if needed
  • All tests passing (mkdocs build --strict clean)

@Chisanan232

Copy link
Copy Markdown
Contributor Author

Claude Code review — AAASM-2936 (python-sdk framework-examples refresh)

CI state

All required checks green: Analyze (python) ✅, Build documentation (PR, no deploy) ✅. Deploy jobs skipping (PR context, expected). mergeable: MERGEABLE; BLOCKED is only the required-review gate.

Scope vs. acceptance criteria

AC (AAASM-2936) Status
No framework with a runnable example still marked "Planned" ✅ LangChain, LangGraph, CrewAI, OpenAI Agents, Pydantic AI, Google ADK flipped to ✅ Validated with links
MCP handled honestly ✅ MCP stays ⏳ Planned — verified agent-assembly-examples/python/mcp returns 404 (no example to claim)
Links each python example in agent-assembly-examples ✅ all 9 surfaced (table + new "More runnable examples" list, incl. framework-free llamaindex-tool-policy, custom-tool-policy)
"Adapter present vs example present" note kept accurate ✅ reworded so ✅ = adapter + runnable example, ⏳ = adapter only (now MCP only)
One PR, base master, granular commits ✅ 3 commits (♻️/♻️/📝), base master

Good catch by the implementer: on canonical master the file is docs/guides/framework-examples.md (the docs/usage/ path was a stale local-checkout artifact) — the real file was edited. Each "Validated" claim was HTTP-200-verified against the examples repo.

Verdict

Ready for approval and merge. No CI to fix; scope complete and accurate.

— Claude Code

@Chisanan232 Chisanan232 changed the title [AAASM-2936] ♻️ (docs): Refresh framework-examples with runnable example links [AAASM-2936] 📝 (docs): Build full multi-page Examples section Jun 14, 2026
@Chisanan232

Copy link
Copy Markdown
Contributor Author

Claude Code review — AAASM-2936 (python-sdk Examples section, expanded)

CI state

Green: Build documentation (PR, no deploy) ✅, Analyze (python) ✅. Deploy jobs skipping (PR context). MERGEABLE; BLOCKED = required-review gate only. mkdocs build --strict passed locally and in CI — proves no broken nav/links across the new section.

Scope vs. refined acceptance criteria

Refined AC Status
Overview page index.md
"Preparing the runtime environment" common page preparing-the-runtime-environment.md — install, clone, real uv run python src/main.py (+--mock), mock vs real-provider
Framework-support table retained framework-support.md (git mv of the refreshed adapter↔example table, re-linked)
One detailed page per example (9) langchain-basic-agent, langchain-research-agent, langgraph, crewai-research-crew, openai-agents-sdk, pydantic-ai, google-adk, llamaindex-tool-policy, custom-tool-policy
Per-page template (what/framework/how it works/setup&run/walkthrough/notes/expected/links) ✅ confirmed (spot-checked crewai-research-crew: all sections + !!! tip/!!! note, real approval-gate + daily-budget policy walkthrough, verbatim expected output)
Grounded in real README + src; nav wired into mkdocs.yml ✅ Examples nav section added; inbound refs repointed; #langchain-quick-start anchor preserved
Granular commits, base master ✅ 13 commits (one page each)

Accuracy note for the record: the examples read AGENT_ASSEMBLY_GATEWAY_URL (default :8080) from their own main.py, not the SDK's AASM_*/:7391 resolver — the setup page reconciles both schemes so readers aren't misled. Correct call.

Verdict

Ready for approval and merge. CI green; refined scope fully covered; content source-accurate.

— Claude Code

@Chisanan232 Chisanan232 merged commit 544f2e9 into master Jun 14, 2026
4 checks passed
@Chisanan232 Chisanan232 deleted the v0.0.1/AAASM-2936/python_docs_examples branch June 14, 2026 12:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant